v3.3.0

Compare Source

Minor Changes

• #​9151 b7dacb21f Thanks @​'./user/schema.mappers#UserMapper',! - Add watchPattern config option for generates sections.

  By default, watch mode automatically watches all GraphQL schema and document files. This means when a change is detected, Codegen CLI is run.

  A user may want to run Codegen CLI when non-schema and non-document files are changed. Each generates section now has a watchPattern option to allow more file patterns to be added to the list of patterns to watch.

  In the example below, mappers are exported from schema.mappers.ts files. We want to re-run Codegen if the content of *.mappers.ts files change because they change the generated types file. To solve this, we can add mapper file patterns to watch using the glob pattern used for schema and document files.

  // codegen.ts
  const config: CodegenConfig = {
    schema: 'src/schema/**/*.graphql',
    generates: {
      'src/schema/types.ts': {
        plugins: ['typescript', 'typescript-resolvers'],
        config: {
          mappers: {
  
            Book: './book/schema.mappers#BookMapper',
          },
        }
        watchPattern: 'src/schema/**/*.mappers.ts', // Watches mapper files in `watch` mode. Use an array for multiple patterns e.g. `['src/*.pattern1.ts','src/*.pattern2.ts']`
      },
    },
  };

  Then, run Codegen CLI in watch mode:

  yarn graphql-codegen --watch

  Now, updating *.mappers.ts files re-runs Codegen! 🎉

  Note: watchPattern is only used in watch mode i.e. running CLI with --watch flag.

Patch Changes

• Updated dependencies [b7dacb21f, f104619ac]:
  • @​graphql-codegen/plugin-helpers@​4.2.0

v3.2.2

Compare Source

Patch Changes

• #​9086 a34cef35b Thanks @​beerose! - dependencies updates:

  • Updated dependency graphql-config@^4.5.0 ↗︎ (from ^4.4.0, in dependencies)
  • Added dependency jiti@^1.17.1 ↗︎ (to dependencies)
  • Removed dependency cosmiconfig-typescript-loader@^4.3.0 ↗︎ (from dependencies)
  • Removed dependency ts-node@^10.9.1 ↗︎ (from dependencies)

• #​9086 a34cef35b Thanks @​beerose! - Support codegen.ts in ESM projects

v3.2.1

Compare Source

Patch Changes

• #​9051 f7313f7ca Thanks @​saihaj! - dependencies updates:

  • Added dependency micromatch@^4.0.5 ↗︎ (to dependencies)

• #​9051 f7313f7ca Thanks @​saihaj! - only run generate for files that users have listed in config to avoid running this over every change that codegen is not supposed to execute

v3.2.0

Compare Source

Minor Changes

• #​9009 288ed0977 Thanks @​saihaj! - use @​parcel/watcher for improved watch functionality

Patch Changes

• #​9009 288ed0977 Thanks @​saihaj! - dependencies updates:
  • Added dependency @parcel/watcher@^2.1.0 ↗︎ (to dependencies)
  • Removed dependency chokidar@^3.5.2 ↗︎ (from dependencies)

v3.1.0

Compare Source

Minor Changes

• #​8893 a118c307a Thanks @​n1ru4l! - It is no longer mandatory to declare an empty plugins array when using a preset

• #​8723 a3309e63e Thanks @​kazekyo! - Introduce a new feature called DocumentTransform.

  DocumentTransform is a functionality that allows you to modify documents before they are processed by plugins. You can use functions passed to the documentTransforms option to make changes to GraphQL documents.

  To use this feature, you can write documentTransforms as follows:

  import type { CodegenConfig } from '@​graphql-codegen/cli';
  
  const config: CodegenConfig = {
    schema: 'https://localhost:4000/graphql',
    documents: ['src/**/*.tsx'],
    generates: {
      './src/gql/': {
        preset: 'client',
        documentTransforms: [
          {
            transform: ({ documents }) => {
              // Make some changes to the documents
              return documents;
            },
          },
        ],
      },
    },
  };
  export default config;

  For instance, to remove a @localOnlyDirective directive from documents, you can write the following code:

  import type { CodegenConfig } from '@​graphql-codegen/cli';
  import { visit } from 'graphql';
  
  const config: CodegenConfig = {
    schema: 'https://localhost:4000/graphql',
    documents: ['src/**/*.tsx'],
    generates: {
      './src/gql/': {
        preset: 'client',
        documentTransforms: [
          {
            transform: ({ documents }) => {
              return documents.map(documentFile => {
                documentFile.document = visit(documentFile.document, {
                  Directive: {
                    leave(node) {
                      if (node.name.value === 'localOnlyDirective') return null;
                    },
                  },
                });
                return documentFile;
              });
            },
          },
        ],
      },
    },
  };
  export default config;

  DocumentTransform can also be specified by file name. You can create a custom file for a specific transformation and pass it to documentTransforms.

  Let's create the document transform as a file:

  module.exports = {
    transform: ({ documents }) => {
      // Make some changes to the documents
      return documents;
    },
  };

  Then, you can specify the file name as follows:

  import type { CodegenConfig } from '@​graphql-codegen/cli';
  
  const config: CodegenConfig = {
    schema: 'https://localhost:4000/graphql',
    documents: ['src/**/*.tsx'],
    generates: {
      './src/gql/': {
        preset: 'client',
        documentTransforms: ['./my-document-transform.js'],
      },
    },
  };
  export default config;

Patch Changes

• #​9000 4c422ccf6 Thanks @​renovate! - dependencies updates:
  • Updated dependency @whatwg-node/fetch@^0.8.0 ↗︎ (from ^0.6.0, in dependencies)
• Updated dependencies [8206b268d, 8206b268d, a118c307a, a3309e63e]:
  • @​graphql-codegen/core@​3.1.0
  • @​graphql-codegen/plugin-helpers@​4.1.0

v3.0.0

Compare Source

Major Changes

• #​8885 fd0b0c813 Thanks @​n1ru4l! - drop Node.js 12 support

Patch Changes

• #​8883 321d5112e Thanks @​Solo-steven! - Fix PluckConfig overwrite problem.

• Updated dependencies [fc79b65d4, fd0b0c813]:

  • @​graphql-codegen/core@​3.0.0
  • @​graphql-codegen/plugin-helpers@​4.0.0

v3.0.1

Compare Source

Patch Changes

• #​8879 8206b268d Thanks @​renovate! - dependencies updates:
  • Updated dependency tslib@~2.5.0 ↗︎ (from ~2.4.0, in dependencies)
• Updated dependencies [8206b268d, a118c307a, a3309e63e]:
  • @​graphql-codegen/plugin-helpers@​4.1.0

v3.0.0

Compare Source

Major Changes

• #​8885 fd0b0c813 Thanks @​n1ru4l! - drop Node.js 12 support

Patch Changes

• Updated dependencies [fc79b65d4, fd0b0c813]:
  • @​graphql-codegen/plugin-helpers@​4.0.0

v3.0.3

Compare Source

Patch Changes

• #​9150 92d86b009 Thanks @​rliljest! - Properly escape enum identifiers when enumsAsConst is used

• Updated dependencies [e56790104, b7dacb21f, f104619ac, acb647e4e, 9f4d9c5a4]:

  • @​graphql-codegen/visitor-plugin-common@​3.1.0
  • @​graphql-codegen/plugin-helpers@​4.2.0

v3.0.2

Compare Source

Patch Changes

• Updated dependencies [ba0610bbd, 4b49f6fbe, b343626c9]:
  • @​graphql-codegen/visitor-plugin-common@​3.0.2

v3.0.1

Compare Source

Patch Changes

• #​8879 8206b268d Thanks @​renovate! - dependencies updates:
  • Updated dependency tslib@~2.5.0 ↗︎ (from ~2.4.0, in dependencies)
• Updated dependencies [8206b268d, 8206b268d, 8206b268d, a118c307a, 6b6fe3cbc, a3309e63e]:
  • @​graphql-codegen/plugin-helpers@​4.1.0
  • @​graphql-codegen/schema-ast@​3.0.1
  • @​graphql-codegen/visitor-plugin-common@​3.0.1

v3.0.0

Compare Source

Major Changes

• #​8885 fd0b0c813 Thanks @​n1ru4l! - drop Node.js 12 support

Patch Changes

• Updated dependencies [fc79b65d4, fd0b0c813]:
  • @​graphql-codegen/visitor-plugin-common@​3.0.0
  • @​graphql-codegen/plugin-helpers@​4.0.0
  • @​graphql-codegen/schema-ast@​3.0.0

v3.1.0

Compare Source

Minor Changes

• #​9146 9f4d9c5a4 Thanks @​eddeee888! - [typescript-resolvers] Add resolversNonOptionalTypename config option.

  This is extending on ResolversUnionTypes implemented in https://github.com/dotansimha/graphql-code-generator/pull/9069

  resolversNonOptionalTypename adds non-optional __typename to union members of ResolversUnionTypes, without affecting the union members' base intefaces.

  A common use case for non-optional __typename of union members is using it as the common field to work out the final schema type. This makes implementing the union's __resolveType very simple as we can use __typename to decide which union member the resolved object is. Without this, we have to check the existence of field/s on the incoming object which could be verbose.

  For example, consider this schema:

  type Query {
    book(id: ID!): BookPayload!
  }
  
  type Book {
    id: ID!
    isbn: String!
  }
  
  type BookResult {
    node: Book
  }
  
  type PayloadError {
    message: String!
  }
  
  union BookPayload = BookResult | PayloadError

  With optional __typename: We need to check existence of certain fields to resolve type in the union resolver:

  // Query/book.ts
  export const book = async () => {
    try {
      const book = await fetchBook();
      // 1. No `__typename` in resolver results...
      return {
        node: book,
      };
    } catch (e) {
      return {
        message: 'Failed to fetch book',
      };
    }
  };
  
  // BookPayload.ts
  export const BookPayload = {
    __resolveType: parent => {
      // 2. ... means more checks in `__resolveType`
      if ('message' in parent) {
        return 'PayloadError';
      }
      return 'BookResult';
    },
  };

  With non-optional __typename: Resolvers declare the type. This which gives us better TypeScript support in resolvers and simplify __resolveType implementation:

  // Query/book.ts
  export const book = async () => {
    try {
      const book = await fetchBook();
      // 1. `__typename` is declared in resolver results...
      return {
        __typename: 'BookResult', // 1a. this also types `node` for us 🎉
        node: book,
      };
    } catch (e) {
      return {
        __typename: 'PayloadError',
        message: 'Failed to fetch book',
      };
    }
  };
  
  // BookPayload.ts
  export const BookPayload = {
    __resolveType: parent => parent.__typename, // 2. ... means a very simple check in `__resolveType`
  };

  Using resolversNonOptionalTypename: add it into typescript-resolvers plugin config:

  // codegen.ts
  const config: CodegenConfig = {
    schema: 'src/schema/**/*.graphql',
    generates: {
      'src/schema/types.ts': {
        plugins: ['typescript', 'typescript-resolvers'],
        config: {
          resolversNonOptionalTypename: true, // Or `resolversNonOptionalTypename: { unionMember: true }`
        },
      },
    },
  };

Patch Changes

• #​9206 e56790104 Thanks @​eddeee888! - Fix ResolversUnionTypes being used in ResolversParentTypes

  Previously, objects with mappable fields are converted to Omit format that references its own type group or ResolversTypes or ResolversParentTypes e.g.

  export type ResolversTypes = {
    Book: ResolverTypeWrapper<BookMapper>;
    BookPayload: ResolversTypes['BookResult'] | ResolversTypes['StandardError'];
    // Note: `result` on the next line references `ResolversTypes["Book"]`
    BookResult: ResolverTypeWrapper<Omit<BookResult, 'result'> & { result?: Maybe<ResolversTypes['Book']> }>;
    StandardError: ResolverTypeWrapper<StandardError>;
  };
  
  export type ResolversParentTypes = {
    Book: BookMapper;
    BookPayload: ResolversParentTypes['BookResult'] | ResolversParentTypes['StandardError'];
    // Note: `result` on the next line references `ResolversParentTypes["Book"]`
    BookResult: Omit<BookResult, 'result'> & { result?: Maybe<ResolversParentTypes['Book']> };
    StandardError: StandardError;
  };

  In https://github.com/dotansimha/graphql-code-generator/pull/9069, we extracted resolver union types to its own group:

  export type ResolversUnionTypes = {
    // Note: `result` on the next line references `ResolversTypes["Book"]` which is only correct for the `ResolversTypes` case
    BookPayload: (Omit<BookResult, 'result'> & { result?: Maybe<ResolversTypes['Book']> }) | StandardError;
  };
  
  export type ResolversTypes = {
    Book: ResolverTypeWrapper<BookMapper>;
    BookPayload: ResolverTypeWrapper<ResolversUnionTypes['BookPayload']>;
    BookResult: ResolverTypeWrapper<Omit<BookResult, 'result'> & { result?: Maybe<ResolversTypes['Book']> }>;
    StandardError: ResolverTypeWrapper<StandardError>;
  };
  
  export type ResolversParentTypes = {
    Book: BookMapper;
    BookPayload: ResolversUnionTypes['BookPayload'];
    BookResult: Omit<BookResult, 'result'> & { result?: Maybe<ResolversParentTypes['Book']> };
    StandardError: StandardError;
  };

  This change creates an extra ResolversUnionParentTypes that is referenced by ResolversParentTypes to ensure backwards compatibility:

  export type ResolversUnionTypes = {
    BookPayload: (Omit<BookResult, 'result'> & { result?: Maybe<ResolversParentTypes['Book']> }) | StandardError;
  };
  
  // ... and the reference is changed in ResolversParentTypes:
  export type ResolversParentTypes = {
    // ... other fields
    BookPayload: ResolversUnionParentTypes['BookPayload'];
  };

• #​9194 acb647e4e Thanks @​dstaley! - Don't emit import statements for unused fragments

• Updated dependencies [b7dacb21f, f104619ac]:

  • @​graphql-codegen/plugin-helpers@​4.2.0

v3.0.2

Compare Source

Patch Changes

• #​9110 ba0610bbd Thanks @​gilgardosh! - Custom mappers with placeholder will apply omit

• #​9069 4b49f6fbe Thanks @​eddeee888! - Extract union types to ResolversUnionTypes

• #​8895 b343626c9 Thanks @​benkroeger! - Preserve .js extension when importDocumentNodeExternallyFrom and emitLegacyCommonJSImports is false

v3.0.1

Compare Source

Patch Changes

• #​8879 8206b268d Thanks @​renovate! - dependencies updates:

  • Updated dependency tslib@~2.5.0 ↗︎ (from ~2.4.0, in dependencies)

• #​8971 6b6fe3cbc Thanks @​n1ru4l! - Always inline referenced fragments within their document. This prevents issues with duplicated fragments or missing fragments.

• Updated dependencies [8206b268d, a118c307a, a3309e63e]:

  • @​graphql-codegen/plugin-helpers@​4.1.0

v3.0.0

Compare Source

Major Changes

• #​8885 fd0b0c813 Thanks @​n1ru4l! - drop Node.js 12 support

Patch Changes

• #​8871 fc79b65d4 Thanks @​B2o5T! - eslint fixes

• Updated dependencies [fc79b65d4, fd0b0c813]:

  • @​graphql-codegen/plugin-helpers@​4.0.0